/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2016 ForgeRock AS.
 */

package org.forgerock.openam.notifications;

import org.forgerock.json.JsonValue;

/**
 * A consumer is associated with a given subscription and is passed notifications
 * by the broker for the topics that the subscription is bound to.
 * <p>
 * Notifications are expected to be in the format:
 * <pre>
 *     {
 *         "topic": "/some/topic",
 *         "timestamp": "2016-01-01T12:00:00.000Z",
 *         "body": {
 *             ... some body here ...
 *         }
 *     }
 * </pre>
 *
 * @since 14.0.0
 */
public interface Consumer {

    /**
     * Accepts the given notification.
     *
     * @param notification a non-null notification
     */
    void accept(JsonValue notification);

}
